/*
 * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package javax.xml.transform.sax;

import javax.xml.transform.Result;
import javax.xml.transform.Transformer;

import org.xml.sax.ContentHandler;
import org.xml.sax.DTDHandler;
import org.xml.sax.ext.LexicalHandler;

/**
 * A TransformerHandler
 * listens for SAX ContentHandler parse events and transforms
 * them to a Result.
 */
public interface TransformerHandler
    extends ContentHandler, LexicalHandler, DTDHandler {

  /**
   * <p>Set  the <code>Result</code> associated with this
   * <code>TransformerHandler</code> to be used for the transformation.</p>
   *
   * @param result A <code>Result</code> instance, should not be <code>null</code>.
   * @throws IllegalArgumentException if result is invalid for some reason.
   */
  public void setResult(Result result) throws IllegalArgumentException;

  /**
   * Set the base ID (URI or system ID) from where relative
   * URLs will be resolved.
   *
   * @param systemID Base URI for the source tree.
   */
  public void setSystemId(String systemID);

  /**
   * Get the base ID (URI or system ID) from where relative
   * URLs will be resolved.
   *
   * @return The systemID that was set with {@link #setSystemId}.
   */
  public String getSystemId();

  /**
   * <p>Get the <code>Transformer</code> associated with this handler, which
   * is needed in order to set parameters and output properties.</p>
   *
   * @return <code>Transformer</code> associated with this <code>TransformerHandler</code>.
   */
  public Transformer getTransformer();
}
